BEFORE YOU BEGIN:
If you haven't already, extract (unzip) DeepgramApp.zip into any folder.


RUNNING THE DEEPGRAM APP

Step 1: Launch the App.
Run DeepgramApp.exe. You may see a warning because the file is unsigned. Click "More info" and then "Run Anyway". If your antivirus flags a concern, verify the file's safety by uploading DeepgramApp.exe to virustotal.com (which uses multiple antivirus engines).

Step 2: Privacy Note.
This app does not store your data. It sends your audio to Deepgram for speech-to-text processing, displays the resulting text, and passes that text to the Chat AI. Deepgram has a strong privacy policy. However, if you are especially concerned about privacy, consider using a VPN to hide your IP address. Note that a server is always handling your speech-to-text data (in vamX AI Chat, it is either OpenAI's Whisper or Deepgram, depending on your language).

Step 3: Configure Audio and Server Settings.
Select your preferred microphone. Choose the same server as you are using in Virt-a-Mate (US, EU, or Global Server). Enter the current AI Chat password. If you are not speaking English, select your language from the "Select Language" drop-down.

Step 4: Enter Your Unique Key in the Secret Key / ID field.
You must enter your unique key located in VaM\Saves\PluginData\vamX\vamX_ai_chat_key.txt. If this file does not exist, launch the vamX AI Chat scene once to generate it. If you do not enter the matching unique key and latest password, your voice will not be sent to your chat.

Step 5: Open vamX AI Chat, then press "Press Here to Start Listening" in the Deepgram App.

Step 6: Avoid Duplicate Speech Recognition.
There is currently no option to disable in-game speech recognition. Do not hold down the right mouse button or VR trigger button while speaking to avoid duplicate inputs. Alternatively, change the default microphone (since vamX AI Chat uses the default) so that only DeepgramApp performs speech recognition.

Step 7: Prevent Your Microphone from Capturing the AI's Output.
If you see the AI’s responses appearing as if you had spoken them (for example, typed out in the Deepgram App or in the AI Chat Windows), it means your microphone is picking up your headset audio. In that case, lower your headset volume or reduce your microphone input volume in Windows.


END OF SPEECH KEYWORD

When you stop speaking, everything you've said is sent to the AI for a response. To determine when you have finished speaking, use the Send Delay drop-down. Select "After Keyword Only" to send your input immediately when you speak an end-of-phrase keyword. For example, if you choose "Jenny" as your keyword, say "Jenny" at the end of your statement (e.g., "Let's go to the movies Jenny"). Your keyword is removed, so you can choose any word without messing up your conversation. If your keyword is Potato, and you say "Let's go to the movies Potato" the AI will only receive "Let's go to the movies."


BUILDING CUSTOM PERSONALITY SETS WITH DEEPGRAM

Step 1: Create Personality Files.
Save each personality in its own .txt file using a simple text editor such as Notepad. The file name (for example, Sarah.txt) will be used as the personality name in the web interface. Note that you cannot add thumbnail images for your personalities.

Step 2: Organize Your Personalities.
Create a folder inside the Deepgram/personalities directory. For example, you might create a folder called "My Personalities" inside Deepgram/personalities. You may place all your personality files in one folder or create multiple folders for different personality sets (for example, a folder named "Police Station" for police-related personalities).

Step 3: Launch vamX AI Chat.
Open the vamX AI Chat scene in Virt-a-Mate.

Step 4: Select Your Personality Set.
Open the Deepgram app and select your personality set from the Personality Folder drop-down menu.

Step 5: Using Your Custom Personalities.
Your custom personality list will appear in the web interface instead of the default list. If you reset the vamX Chat AI, you will need to reselect your personality set in Deepgram. If you do not enter the matching unique key and latest password, your custom personality set will not be sent to your chat.